A5.ControlBarItem Button List Object
Description
Definition of a button list.
Properties
- typestring
The type of item. For a button list item the value must be "button-list".
- sizestring
The size of the item.
- autoHideDisclosurestring
Whether or not to hide the disclosure when the button list is clicked. The default is "auto" which will close the disclosure if the A5.ControlBar.showDisclosure methods settings autoHide property is set to true, but leave it open if it is false. A value of "always" will always hide the disclosure. A value of "never" will never hide the disclosure.
- actionsobject
Bindings of events to named actions. The property names are those of events that occur on the item. Values are "click", "down", "up", "downhold", "contextclick", "dblclick" and "swipe". The value of these properties is then name of the action to fire when the event occurs. If an action named "back" should fire then the user clicks the item, the JSON would be "{click: 'back'}".
- settingsobject
The settings for the button.
- themestring
The theme to use for the button.
- multipleboolean
Whether or not to allow multiple values to be selected.
- allowNullSelectionboolean
Whether or not to allow no value to be selected.
- fillstring
Whether the buttons should fill the width or height of the button list container. Values are "none", "width" or "height".
- classNamestring
The class name to put on the element that contains the button list.
- nullSelectionClassNamestring
The class name to put on the element that contains the button list when no value is selected.
- buttonobject
Settings for buttons in the button list.
- keepPressedboolean
Whether or not to keep buttons pressed when they are selected.
- layoutstring
The layout of a button in the button. Values are "text", "icon", "text icon", "icon text", "text/icon", "icon/text", "text-icon" and "icon-text".
- stylestring
The inline CSS to put on a button in the list.
- classNamestring
The class name to put on a button in the list.
- firstClassNamestring
The class name to put on the first button in the list.
- lastClassNamestring
The class name to put on the last button in the list.
- middleClassNamestring
The class name to put on any button in the list that isn't the first or last.
- hoverClassNamestring
The class name to put on a button in the list when the user hovers over it.
- pressedClassNamestring
The class name to put on a button in the list when the user presses it.
- disabledClassNamestring
The class name to put on a button in the list when it is disabled.
- iconStylestring
The inline CSS to put on the icon in a button in the list.
- iconClassNamestring
The class name to put on the icon in a button in the list.
- bindobject
Bindings for the item.
- valuestring
The path to the property in the data that the value for the button list is stored. The property must be an array if the button list supports multiple selection.
- datastring
The path to the property in the data in which the button definitions for a button list are stored. The property must be an array. If the buttons only use text layout, the data can be an array of strings which will be both the display, and value of the button in the list. Otherwise the array must contain objects that specify the "html", "icon", and "value" to use. It may also specify "iconHover", "iconPressed" and "iconDisabled". Disabling buttons can be done by setting a property named "disabled" to a value of "true". Hiding buttons can be done by setting a property of "show" to a value of "false".
- showstring
The show expression for the item.